Skip to content

docs(readme): add import statement for pure REST usage to align with other examples #10838

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 20, 2025

Conversation

Youzi9601
Copy link
Contributor

This PR updates the "Independent REST API Usage" section in the README to include the appropriate import statements, ensuring consistency with the structure and format of other examples in the documentation. This makes the usage clearer and aligns with the overall style of the README.

…other examples

Added missing `import` statements in the "Independent REST API Usage" section to maintain consistency with the rest of the README examples.  
This change also ensures that the usage of `@discordjs/core` reflects a REST-only setup by importing from `@discordjs/core/http-only`, which avoids dependency issues like `Can't resolve 'zlib-sync'`.
Copy link

vercel bot commented Apr 19, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
discord-js ⬜️ Ignored (Inspect) Visit Preview Apr 20, 2025 1:57pm

@Youzi9601 Youzi9601 changed the title docs(readme): add import statement for pure REST usage to align with … docs(readme): add import statement for pure REST usage to align with other examples Apr 19, 2025
@Youzi9601
Copy link
Contributor Author

The example now uses @discordjs/core/http-only to reflect a REST-only usage pattern, which avoids requiring additional dependencies like zlib-sync that are unnecessary for this context.

@github-project-automation github-project-automation bot moved this from Todo to Review Approved in discord.js Apr 20, 2025
@kodiakhq kodiakhq bot merged commit 8f35dfd into discordjs:main Apr 20, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from Review Approved to Done in discord.js Apr 20, 2025
@Youzi9601 Youzi9601 deleted the patch-1 branch April 20, 2025 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants